home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / nwsf121.zip / README.TXT < prev   
Text File  |  1995-03-19  |  7KB  |  203 lines
  1. NEWSFLSH.PPE is a small PPE to diplay a text file containing date
  2. headers and entries for a specified number of days.
  3. Compiled with PPLC v3.0. Requires PCBoard 15.2+ to run.
  4.  
  5. To start, this PPE is FREEWARE. If you call my BBS:
  6.  
  7.                 Blackbeard's BBS
  8.                 (901) -925-2503  Zoom 14.4 VFP
  9.  
  10. and Join Conference #5, there is an on-line registration PPE which will
  11. create your free KEY file and Download it. There are no delays in the PPE,
  12. only an UNREGISTERED message in the banner.
  13.   This method will also provide me with a way to see how many people
  14. actually decide to use the PPE (or at least test it).
  15.  
  16. -----------
  17. |NEW ITEMS|
  18. -----------
  19.  
  20. Language/Security/Graphic specific Header File
  21. Language specific News File
  22.  
  23. RANDOM color schemes are now more random and less likely to duplicate
  24.        colors in the date and separator fields.
  25.  
  26. -------------
  27. |Intructions|
  28. -------------
  29. Unzip this PPE and accompaning files to the subdirectory of your choice.
  30. NOTE: You may keep your original NEWSFLSH.CFG file, it will work correctly
  31. with this update, but you might want to edit it to add the RANDOM option.
  32.  
  33. To install this PPE, Just place it in your NEWS file. You do so by adding
  34. the line:
  35. !d:\pcb\ppe\newsflsh\newsflsh.ppe
  36.  
  37. in your NEWS file, replacing the appropriate drive and path information.
  38.  
  39. -------------
  40. |Config File|
  41. -------------
  42.  
  43. Next edit the config file. It must be named NEWSFLSH.CFG and must reside
  44. in the same directory as the PPE. The config file has 4 lines:
  45.  
  46. -------------- Sample NEWSFLSH.CFG --------------------
  47. NEWZ
  48. 120
  49. 4A
  50. 0F
  51. 0C
  52.  
  53. ;NEWSFLSH.CFG file
  54. ;Line 1: NEWS file to display.
  55.     Files must reside in the same directory as the    NEWSFLSH.PPE
  56. ;Line 2: Max # of Days to show news entries in news file
  57. ;Line 3: Date Heading @X color attribute without @X
  58. ;Line 4: Text @X Color Attribute without @X
  59. ;Line 5: Separator Bar @X color attribute without @X
  60. ;NOTE-placing the word RANDOM in lines 3-5 will generate a different
  61. ;     color combination for that item each time the PPE is run. I have
  62. ;     excluded the hardest to read combinations.
  63.  
  64. ---------------End Sample -----------------------------
  65.  
  66. All blank lines and lines starting with a ';' are considered comments
  67. The only required entry is the name of the news file to display unless
  68. it is entered on the command line (see CMD Line Options)
  69. The rest of the entries will default to the above values if they are
  70. missing.
  71.  
  72. *Notes- When RANDOM is chosen, text will be be random forground on black
  73.         background. Also, with the lifting of the 78 character line limit
  74.         for text entries, I recommend only using black background unless
  75.         you make sure each line is EXACTLY the same length.
  76.         The same colors will not be used for forground and background for any
  77.         color attributes and I have removed the hardest color combinations
  78.         to read too.
  79.  
  80. -----------------
  81. |News Entry File|
  82. -----------------
  83.  
  84. The News file entered in the CONFIG file is a plain text file with the
  85. following format
  86.  
  87. ~~MM/DD/YY
  88.   This is news entry #1
  89. ~~MM/DD/YY
  90.   This is text #2
  91.  
  92.  
  93.        All date headers must follow the 'MM/DD/YY' or 'MM-DD-YY' format and be
  94. preceded by '~~' without the quotes. The ~~ characters will not be displayed.
  95. Once an entry's date is older than the number of days specified in the config
  96. file, the rest of the news file will be ignored. Do not include @X codes
  97. in the date headers.
  98.        After the date is printed, a separator bar is printed in the color
  99. defined in the config file, or the default if none is entered.
  100.        Text entries can be any news description you wish, including @X color
  101. codes. The PPE will start each line with the color code in the config file
  102. so any changes you make must be done for each line.
  103.  
  104.  
  105. ----------------
  106. |Optional Files|
  107. ----------------
  108.  
  109.  
  110. If the File NFHDR exists in the PPE directory, it will be displayed
  111. prior to the actual news entries. This file should NOT include a @cls@
  112. macro as the PPE will clear the screen automatically before it is displayed.
  113. This file may have Security, Graphics, and Language versions as well
  114. (ie. NFHDR50R.FRE would be displayed to all level 50 Ripgraphics users
  115. using the FRE language. If notfound, the default file will be displayed)
  116.  
  117. *NOTE - current users may rename their NEWSFLSH.HDR to NFHDR*
  118.  
  119.  
  120. If the file NEWSFLSH.KEY exists in the PPE directory, the Registration
  121. information will replace the UNREGISTERED notice before the News is displayed
  122. IF it is a valid key file and contains the correct information.
  123. You shouldn't need to get a new one if it already exists. If you lose it, you
  124. can call my BBS and re-run the Registration PPE (NKEY) in Conference #5 to get
  125. another. No changes were made to the format so you shouldn't need a new one
  126. unless your old one isn't working.
  127.  
  128. ------------------
  129. |CMD Line Options|
  130. ------------------
  131.  
  132. The PPE now supports 2 Command line options- MAINT and a FileName
  133.  
  134. Filename example:
  135. !C:\PCB\PPE\NEWSFLSH.PPE Filename
  136.  
  137. If you include the filename (no paths) after the PPE, it will override
  138. the filename used in the config file. With this option you can "do away"
  139. with the config file completely, and use the default values instead!
  140. Langauge specific files for the Filename will be displayed if they
  141. exist.
  142.  
  143. MAINT examples (used for event processing):
  144.  
  145. PCBOARD "/PPE:c:\path\NEWSFLSH.PPE MAINT [Filename]"
  146.  
  147. *Note* The Quotation Marks are REQUIRED for proper execution.
  148.  
  149. This method is handy for keeping your News File trimmed. It can be
  150. added to your Nightly, Weekly, Monthly...event to keep the file
  151. size limited.
  152.  
  153. What the MAINT option does is run through the NewsFile and remove
  154. entries older than the number of days in the config file or the default
  155. if no config file exists. It does not check every entry, but rather stops
  156. at the FIRST entry that is older; any entries after that are also removed.
  157. Each line that is kept will be displayed to the local screen.
  158.     If a filename is also included after the MAINT option, maintenance
  159. will be performed on that file instead. The Filename MUST come after
  160. the MAINT option for this method to work, and it must reside in the same
  161. directory as the PPE.
  162.  
  163. The Maintenance option creates a temporary file which holds all the entries
  164. that have been kept. Once the newsfile has been processed, it renames the
  165. temporary file to the original news filename and then deletes the temporary
  166. file.
  167.  
  168. -------------
  169. |Final Notes|
  170. -------------
  171.  
  172. This PPE works for me and should work for you. If you have any problems,
  173. I can can be reached at my BBS listed above, or on Intelec or U'NI-net.
  174.  
  175. ----------------------
  176. |Planned enhancements|
  177. ----------------------
  178.  
  179. I may add the ability to define multiple news files if someone wants it
  180. and explains HOW they want it to work (by CONF, SEC, whatever).
  181.  
  182. Any other enhancement you might want? Call and request your Reg. Key
  183. from my BBS and leave the request in your comment. If it's feasible
  184. I'll do it!
  185.  
  186.  
  187. The only guarantee is that this program will take up disk space. If it
  188. doesn't work for you, I'll try to fix it. It works for me, and it's free,
  189. so expecting too much isn't recommended.
  190.  
  191.  
  192. ▌▌   Herbert Bushong
  193. ▌▌    Team PCBoard
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.